home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Misc Servers / Zope.exe / HELPUTIL.PY < prev    next >
Encoding:
Text File  |  2000-05-26  |  15.2 KB  |  500 lines
  1. ##############################################################################
  2. # 
  3. # Zope Public License (ZPL) Version 1.0
  4. # -------------------------------------
  5. # 
  6. # Copyright (c) Digital Creations.  All rights reserved.
  7. # 
  8. # This license has been certified as Open Source(tm).
  9. # 
  10. # Redistribution and use in source and binary forms, with or without
  11. # modification, are permitted provided that the following conditions are
  12. # met:
  13. # 
  14. # 1. Redistributions in source code must retain the above copyright
  15. #    notice, this list of conditions, and the following disclaimer.
  16. # 
  17. # 2. Redistributions in binary form must reproduce the above copyright
  18. #    notice, this list of conditions, and the following disclaimer in
  19. #    the documentation and/or other materials provided with the
  20. #    distribution.
  21. # 
  22. # 3. Digital Creations requests that attribution be given to Zope
  23. #    in any manner possible. Zope includes a "Powered by Zope"
  24. #    button that is installed by default. While it is not a license
  25. #    violation to remove this button, it is requested that the
  26. #    attribution remain. A significant investment has been put
  27. #    into Zope, and this effort will continue if the Zope community
  28. #    continues to grow. This is one way to assure that growth.
  29. # 
  30. # 4. All advertising materials and documentation mentioning
  31. #    features derived from or use of this software must display
  32. #    the following acknowledgement:
  33. # 
  34. #      "This product includes software developed by Digital Creations
  35. #      for use in the Z Object Publishing Environment
  36. #      (http://www.zope.org/)."
  37. # 
  38. #    In the event that the product being advertised includes an
  39. #    intact Zope distribution (with copyright and license included)
  40. #    then this clause is waived.
  41. # 
  42. # 5. Names associated with Zope or Digital Creations must not be used to
  43. #    endorse or promote products derived from this software without
  44. #    prior written permission from Digital Creations.
  45. # 
  46. # 6. Modified redistributions of any form whatsoever must retain
  47. #    the following acknowledgment:
  48. # 
  49. #      "This product includes software developed by Digital Creations
  50. #      for use in the Z Object Publishing Environment
  51. #      (http://www.zope.org/)."
  52. # 
  53. #    Intact (re-)distributions of any official Zope release do not
  54. #    require an external acknowledgement.
  55. # 
  56. # 7. Modifications are encouraged but must be packaged separately as
  57. #    patches to official Zope releases.  Distributions that do not
  58. #    clearly separate the patches from the original work must be clearly
  59. #    labeled as unofficial distributions.  Modifications which do not
  60. #    carry the name Zope may be packaged in any form, as long as they
  61. #    conform to all of the clauses above.
  62. # 
  63. # 
  64. # Disclaimer
  65. # 
  66. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  67. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  68. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  69. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  70. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  71. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  72. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  73. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  74. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  75. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  76. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  77. #   SUCH DAMAGE.
  78. # 
  79. # 
  80. # This software consists of contributions made by Digital Creations and
  81. # many individuals on behalf of Digital Creations.  Specific
  82. # attributions are listed in the accompanying credits file.
  83. # 
  84. ##############################################################################
  85. """Help system support module"""
  86.  
  87. __version__='$Revision: 1.7 $'[11:-2]
  88.  
  89.  
  90. import Globals, Acquisition
  91. import StructuredText.StructuredText
  92. import sys, os, string, regex
  93.  
  94.  
  95. stx_class=StructuredText.StructuredText.HTML
  96.  
  97.  
  98. class HelpBase(Acquisition.Implicit):
  99.     """ """
  100.     def __bobo_traverse__(self, REQUEST, name=None):
  101.         # A sneaky trick - we cant really _have_ an index_html
  102.         # because that would often hide the index_html of a
  103.         # wrapped object ;(
  104.         if name=='index_html':
  105.             return self.hs_index
  106.         return getattr(self, name)
  107.  
  108.     def __len__(self):
  109.         return 1
  110.  
  111.  
  112. class object(Acquisition.Implicit):
  113.     def __init__(self, name, ob, op=None):
  114.         self._name=name
  115.         self._obj_=ob
  116.         self._obp_=op
  117.  
  118.     def __getattr__(self, name):
  119.         return getattr(self.__dict__['_obj_'], name)
  120.  
  121.     def __len__(self):
  122.         return 1
  123.  
  124.     def get_id(self):
  125.         return id(self._obj_)
  126.  
  127.     def get_name(self):
  128.         return self._name
  129.  
  130.     def get_type(self):
  131.         return type(self._obj_).__name__
  132.  
  133.     def get_value(self):
  134.         return self._obj_
  135.  
  136.     def get_docstring(self):
  137.         if hasattr(self._obj_, '__doc__'):
  138.             doc=self._obj_.__doc__
  139.             if not doc: doc=''
  140.             return doc
  141.         return ''
  142.  
  143.     def get_docstring_html(self):
  144.         doc=self.get_docstring()
  145.         if string.find(doc, '\n\n') > -1:
  146.             doc=string.split(doc, '\n\n')
  147.             if len(doc) > 1:
  148.                 doc[1]=string.strip(doc[1])
  149.             doc=string.join(doc, '\n\n')
  150.         
  151.         return str(stx_class(doc))
  152.  
  153.     def version(self):
  154.         if hasattr(self._obj_, '__version__'):
  155.             return self._obj_.__version__
  156.  
  157.     tpId   =get_name
  158.     tpURL  =get_name
  159.     __str__=get_name
  160.  
  161.  
  162. class moduleobject(object):
  163.     def get_file(self):
  164.         if hasattr(self._obj_, '__file__'):
  165.             return self._obj_.__file__
  166.  
  167.     def get_modules(self):
  168.         data=[]
  169.         for name, ob in self._obj_.__dict__.items():
  170.             if is_module(ob) and _chModule(name, ob):
  171.                 data.append(moduleobject(name, ob, self))
  172.         return data
  173.  
  174.     def get_classes(self):
  175.         data=[]
  176.         for name, ob in self._obj_.__dict__.items():
  177.             if is_class(ob) and _chClass(name, ob):
  178.                 data.append(classobject(name, ob, self))
  179.         return data
  180.  
  181.  
  182. class classobject(object):
  183.     def get_metatype(self):
  184.         try: return self._obj_.meta_type
  185.         except:
  186.             t, v, tb = sys.exc_info()
  187.             return '%s %s' % (t, v)
  188.     
  189.     def get_module(self):
  190.         if hasattr(self._obj_, '__module__'):
  191.             module=sys.modules[self._obj_.__module__]
  192.             return moduleobject(module.__name__, module)
  193.         
  194.     def get_file(self):
  195.         return self.get_module().get_file()
  196.  
  197.     def get_bases(self):
  198.         bases=[]
  199.         if hasattr(self._obj_, '__bases__'):
  200.             for base in self._obj_.__bases__:
  201.                 bases.append(classobject(base.__name__, base))
  202.         return bases
  203.  
  204.     def get_base_list(self, list=None):
  205.         if list is None: list=[]
  206.         list.append(self)
  207.         for base in self.get_bases():
  208.             list=base.get_base_list(list)
  209.         return list
  210.  
  211.     def get_methods(self):
  212.         keys=self._obj_.__dict__.keys()
  213.         dict=self._obj_.__dict__
  214.         keys.sort()
  215.         methods=[]
  216.         for name in keys:
  217.             ob=dict[name]
  218.             if is_method(ob) and _chMethod(name, ob):
  219.                methods.append(methodobject(name, ob, self))
  220.         return methods
  221.  
  222.     def get_method_dict(self, dict=None):
  223.         if dict is None:
  224.             dict={}
  225.         dup=dict.has_key
  226.         for method in self.get_methods():
  227.             name=method.get_name()
  228.             if not dup(name):
  229.                 dict[name]=method
  230.         for base in self.get_bases():
  231.             dict=base.get_method_dict(dict)
  232.         return dict
  233.  
  234.     def get_method_list(self):
  235.         dict=self.get_method_dict()
  236.         keys=dict.keys()
  237.         keys.sort()
  238.         list=[]
  239.         for key in keys:
  240.             list.append(dict[key])
  241.         del dict
  242.         return list
  243.  
  244. ##     def obAttributes(self):
  245. ##         # Return list of class attributes
  246. ##         keys=self._obj_.__dict__.keys()
  247. ##         dict=self._obj_.__dict__
  248. ##         keys.sort()
  249. ##         attrs=[]
  250. ##         for name in keys:
  251. ##             ob=dict[name]
  252. ##             if _isAttribute(ob) and _chAttribute(name, ob):
  253. ##                 attrs.append(AttributeObject(name, ob, self))
  254. ##         return attrs
  255.  
  256. ##     def obAttributeDict(self, dict=None):
  257. ##         # Return dict of attrs in class and superclasses
  258. ##         if dict is None:
  259. ##             dict={}
  260. ##             root=1
  261. ##         else: root=0
  262. ##         dup=dict.has_key
  263. ##         for attr in self._obj_Attributes():
  264. ##             name=attr.obName()
  265. ##             if not dup(name):
  266. ##                 dict[name]=attr
  267. ##         for base in self._obj_Bases():
  268. ##             dict=base.obAttributeDict(dict)
  269. ##         return dict
  270.  
  271. ##     def obAttributeList(self):
  272. ##         # Return list of attrs in class and superclasses
  273. ##         dict=self._obj_AttributeDict()
  274. ##         keys=dict.keys()
  275. ##         keys.sort()
  276. ##         list=[]
  277. ##         append=list.append
  278. ##         for name in keys:
  279. ##             append(dict[name])
  280. ##             del dict
  281. ##         return list
  282.  
  283.  
  284.  
  285.  
  286. pre_match=regex.compile('[A-Za-z0-9_]*([^)]*)[ -]*').match #TS
  287. sig_match=regex.compile('[A-Za-z0-9_]*([^)]*)').match #TS
  288.  
  289. class methodobject(object):
  290.  
  291.     def get_class(self):
  292.         return self._obp_
  293.  
  294.     def get_module(self):
  295.         return self.get_class().get_module()
  296.  
  297.     def get_file(self):
  298.         return self.get_module().get_file()
  299.  
  300.     def get_docstring(self):
  301.         func=self._obj_
  302.         doc=''
  303.         if hasattr(func, 'im_func'):
  304.             func=func.im_func
  305.         if hasattr(func, '__doc__'):
  306.             doc=func.__doc__
  307.             if not doc: doc=''
  308.             doc=string.strip(doc)
  309.         if hasattr(func, 'func_code'):
  310.             if hasattr(func.func_code, 'co_varnames'):
  311.                 return doc
  312.         n=pre_match(doc)
  313.         if n > -1:
  314.             return doc[n:]
  315.         return doc
  316.  
  317.     def get_signaturex(self):
  318.         name=self._name
  319.         func=self._obj_
  320.         method=None
  321.  
  322.         if hasattr(func, 'im_func'):
  323.             method=1
  324.             func=func.im_func
  325.  
  326.         # Normal functions
  327.         if hasattr(func, 'func_code'):
  328.             if hasattr(func.func_code, 'co_varnames'):
  329.                 args=map(lambda x: x,
  330.                      func.func_code.co_varnames[:func.func_code.co_argcount])
  331.                 ndefaults=func.func_defaults
  332.                 ndefaults=ndefaults and len(ndefaults) or 0
  333.                 if '__ick__' in args:
  334.                     nick=len(args)-args.index('__ick__')
  335.                     args=args[:-nick]
  336.                     ndefaults=ndefaults-nick
  337.                 if ndefaults > 0:
  338.                     args[-ndefaults]='['+args[-ndefaults]
  339.                     args[-1]=args[-1]+']'
  340.                 if method: args=args[1:]
  341.                 if name=='__call__':
  342.                     name='Call Operation'
  343.                 return '%s(%s)' % (name, string.join(args,', '))
  344.  
  345.         # Other functions - look for something that smells like
  346.         # a signature at the beginning of the docstring.
  347.         if hasattr(func, '__doc__'):
  348.             doc=func.__doc__
  349.             if not doc: doc=''
  350.             doc=string.strip(doc)
  351.             n=sig_match(doc)
  352.             if n > -1:
  353.                 return doc[:n]
  354.         return '%s()' % name
  355.                       
  356.  
  357.     def get_signature(self):
  358.         try: return self.get_signaturex()
  359.         except:
  360.             t, v, tb=sys.exc_info()
  361.             return '%s %s' % (t, v)
  362.  
  363.  
  364. ## class AttributeObject(_ob_):
  365. ##     def obClass(self):
  366. ##         return self.op
  367.  
  368. ##     def obModule(self):
  369. ##         return self.obClass().obModule()
  370.  
  371. ##     def obFile(self):
  372. ##         return self.obModule().obFile()
  373.  
  374. ## class InstanceObject(_ob_):
  375. ##     def obClass(self):
  376. ##         # Return the class for this instance
  377. ##         c=self._obj_.__class__
  378. ##         return ClassObject(c.__name__, c)
  379.  
  380. ##     def obClassList(self):
  381. ##         # Return list of all superclasses
  382. ##         return self._obj_Class().obClassList()
  383.  
  384. ##     def obMethods(self):
  385. ##         # Return list of instance methods
  386. ##         keys=self._obj_.__dict__.keys()
  387. ##         dict=self._obj_.__dict__
  388. ##         keys.sort()
  389. ##         methods=[]
  390. ##         for name in keys:
  391. ##             ob=dict[name]
  392. ##             if _isMethod(ob) and _chMethod(name, ob):
  393. ##                methods.append(MethodObject(name, ob))
  394. ##         return methods
  395.  
  396. ##     def obMethodDict(self):
  397. ##         # Return dict of instance and superclass methods
  398. ##         dict=self._obj_Class().obMethodDict()
  399. ##         for method in self._obj_Methods():
  400. ##             dict[method.obName()]=method
  401. ##         return dict
  402.             
  403. ##     def obMethodList(self):
  404. ##         # Return list of instance and superclass methods
  405. ##         dict=self._obj_MethodDict()
  406. ##         keys=dict.keys()
  407. ##         keys.sort()
  408. ##         list=[]
  409. ##         append=list.append
  410. ##         for name in keys:
  411. ##             append(dict[name])
  412. ##         return list
  413.  
  414. ##     def obAttributes(self):
  415. ##         # Return list of instance attributes
  416. ##         keys=self._obj_.__dict__.keys()
  417. ##         dict=self._obj_.__dict__
  418. ##         keys.sort()
  419. ##         attrs=[]
  420. ##         for name in keys:
  421. ##             ob=dict[name]
  422. ##             if _isAttribute(ob) and _chAttribute(name, ob):
  423. ##                 attrs.append(AttributeObject(name, ob, self))
  424. ##         return attrs
  425.     
  426. ##     def obAttributeDict(self):
  427. ##         # Return dict of instance and superclass attributes
  428. ##         dict=self._obj_Class().obAttributeDict()
  429. ##         for attr in self._obj_Attributes():
  430. ##             dict[attr.obName()]=attr
  431. ##         return dict
  432.             
  433. ##     def obAttributeList(self):
  434. ##         # Return list of instance and superclass attributes
  435. ##         dict=self._obj_AttributeDict()
  436. ##         keys=dict.keys()
  437. ##         keys.sort()
  438. ##         list=[]
  439. ##         append=list.append
  440. ##         for name in keys:
  441. ##             append(dict[name])
  442. ##         return list
  443.  
  444.  
  445.  
  446.  
  447. _classtypes=(type(Globals.HTML),
  448.              type(Globals.Persistent),
  449.             )
  450.  
  451. _methodtypes=(type([].sort),
  452.               type(Globals.default__class_init__),
  453.               type(Globals.HTML.manage_edit),
  454.               type(Globals.HTML.__changed__),
  455.               type(Globals.MessageDialog.manage_edit),
  456.              )
  457.  
  458. def is_module(ob):
  459.     return type(ob)==type(sys)
  460.  
  461. def is_class(ob):
  462.     return type(ob) in _classtypes
  463.  
  464. def is_method(ob):
  465.     if type(ob) in _methodtypes or hasattr(ob, 'func_code'):
  466.         return 1
  467.     return 0
  468.  
  469. def is_attribute(ob):
  470.     return not is_method(ob)
  471.  
  472.  
  473.  
  474. def _chModule(name, ob):
  475.     if name[0]=='_':
  476.         return 0
  477.     return 1
  478.  
  479. def _chClass(name, ob):
  480.     if name[0]=='_':
  481.         return 0
  482.     return 1
  483.  
  484. def _chMethod(name, ob):
  485.     if name[0]=='_':
  486.         return 0
  487.     return 1
  488.  
  489. def _chAttribute(name, ob):
  490.     if name[0]=='_':
  491.         return 0
  492.     return 1
  493.  
  494.  
  495.  
  496.  
  497.  
  498.  
  499.  
  500.